<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__hppass__ac__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__hppass.html">HPPASS       (High Performance Programmable Analog Sub-System)</a> &raquo; <a class="el" href="group__group__hppass__ac.html">AC (Autonomous Controller)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac55d15867c2bd040e826a87bf4e6c69e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#gac55d15867c2bd040e826a87bf4e6c69e">Cy_HPPASS_AC_UpdateStateTransitionTable</a> (uint8_t numEntries, const <a class="el" href="structcy__stc__hppass__ac__stt__t.html">cy_stc_hppass_ac_stt_t</a> *stateTransitionTable, uint8_t startState)</td></tr>
<tr class="memdesc:gac55d15867c2bd040e826a87bf4e6c69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for adding or replacing state into State Transition Table - useful for multiple applications accessing the High Performance Programmable Analog Sub-System.  <a href="#gac55d15867c2bd040e826a87bf4e6c69e">More...</a><br /></td></tr>
<tr class="separator:gac55d15867c2bd040e826a87bf4e6c69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaefc5f954ffaee6506067cac368393d33"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#gaefc5f954ffaee6506067cac368393d33">Cy_HPPASS_AC_LoadStateTransitionTable</a> (uint8_t numEntries, const <a class="el" href="structcy__stc__hppass__ac__stt__t.html">cy_stc_hppass_ac_stt_t</a> *stateTransitionTable)</td></tr>
<tr class="memdesc:gaefc5f954ffaee6506067cac368393d33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuring the State Transition Table of the the Autonomous Controller according to the provided settings.  <a href="#gaefc5f954ffaee6506067cac368393d33">More...</a><br /></td></tr>
<tr class="separator:gaefc5f954ffaee6506067cac368393d33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c1648a12e3a7333ac3e2dcb9973fc92"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#ga0c1648a12e3a7333ac3e2dcb9973fc92">Cy_HPPASS_AC_IsRunning</a> (void)</td></tr>
<tr class="memdesc:ga0c1648a12e3a7333ac3e2dcb9973fc92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the running/stopped status of the Autonomous Controller.  <a href="#ga0c1648a12e3a7333ac3e2dcb9973fc92">More...</a><br /></td></tr>
<tr class="separator:ga0c1648a12e3a7333ac3e2dcb9973fc92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabbf381cbbe92e087faf4c89a549cd1d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#gabbf381cbbe92e087faf4c89a549cd1d7">Cy_HPPASS_AC_Start</a> (uint8_t startState, uint16_t timeoutUs)</td></tr>
<tr class="memdesc:gabbf381cbbe92e087faf4c89a549cd1d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the Autonomous Controller from the specified STT state.  <a href="#gabbf381cbbe92e087faf4c89a549cd1d7">More...</a><br /></td></tr>
<tr class="separator:gabbf381cbbe92e087faf4c89a549cd1d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe3a52cfc422239331c798f8b992ee19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#gafe3a52cfc422239331c798f8b992ee19">Cy_HPPASS_AC_GetState</a> (<a class="el" href="structcy__stc__hppass__state__t.html">cy_stc_hppass_state_t</a> *state)</td></tr>
<tr class="memdesc:gafe3a52cfc422239331c798f8b992ee19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides status of operation for the Autonomous Controller.  <a href="#gafe3a52cfc422239331c798f8b992ee19">More...</a><br /></td></tr>
<tr class="separator:gafe3a52cfc422239331c798f8b992ee19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec00f468edc0706ae7dcb46c86332caa"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__ac__functions.html#gaec00f468edc0706ae7dcb46c86332caa">Cy_HPPASS_AC_IsBlockReady</a> (void)</td></tr>
<tr class="memdesc:gaec00f468edc0706ae7dcb46c86332caa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the AC block ready status.  <a href="#gaec00f468edc0706ae7dcb46c86332caa">More...</a><br /></td></tr>
<tr class="separator:gaec00f468edc0706ae7dcb46c86332caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac55d15867c2bd040e826a87bf4e6c69e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac55d15867c2bd040e826a87bf4e6c69e">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_UpdateStateTransitionTable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_AC_UpdateStateTransitionTable </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>numEntries</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__ac__stt__t.html">cy_stc_hppass_ac_stt_t</a> *&#160;</td>
          <td class="paramname"><em>stateTransitionTable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>startState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Used for adding or replacing state into State Transition Table - useful for multiple applications accessing the High Performance Programmable Analog Sub-System. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">numEntries</td><td>Number of entries of the State Transition Table for replace. Valid range: 1...<a class="el" href="group__group__hppass__macros.html#ga9980dbbf4b8a470ead759833a2598279">CY_HPPASS_AC_STT_SIZE</a>.</td></tr>
    <tr><td class="paramname">stateTransitionTable</td><td>Pointer to array containing new set of configuration data for State Transition Table, which must be replaced or added. The pointer cannot be NULL.</td></tr>
    <tr><td class="paramname">startState</td><td>Defines state in the State Transition Table from which update of the content begins. Valid range: 0...<a class="el" href="group__group__hppass__macros.html#ga9980dbbf4b8a470ead759833a2598279">CY_HPPASS_AC_STT_SIZE</a> - 1.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Combined value of all the subsystem statuses, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>. </dd></dl>

</div>
</div>
<a id="gaefc5f954ffaee6506067cac368393d33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaefc5f954ffaee6506067cac368393d33">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_LoadStateTransitionTable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_AC_LoadStateTransitionTable </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>numEntries</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__ac__stt__t.html">cy_stc_hppass_ac_stt_t</a> *&#160;</td>
          <td class="paramname"><em>stateTransitionTable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuring the State Transition Table of the the Autonomous Controller according to the provided settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">numEntries</td><td>Number of entries in the State Transition Table. Valid range: 1...<a class="el" href="group__group__hppass__macros.html#ga9980dbbf4b8a470ead759833a2598279">CY_HPPASS_AC_STT_SIZE</a>.</td></tr>
    <tr><td class="paramname">stateTransitionTable</td><td>Pointer to array containing configuration data for entire State Transition Table, <a class="el" href="structcy__stc__hppass__ac__stt__t.html">cy_stc_hppass_ac_stt_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Combined value of all the subsystem statuses, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>. </dd></dl>

</div>
</div>
<a id="ga0c1648a12e3a7333ac3e2dcb9973fc92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0c1648a12e3a7333ac3e2dcb9973fc92">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_IsRunning()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE bool Cy_HPPASS_AC_IsRunning </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the running/stopped status of the Autonomous Controller. </p>
<dl class="section return"><dt>Returns</dt><dd>Running status: true - running, false - stopped. </dd></dl>

</div>
</div>
<a id="gabbf381cbbe92e087faf4c89a549cd1d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabbf381cbbe92e087faf4c89a549cd1d7">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_Start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_AC_Start </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>startState</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>timeoutUs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Starts the Autonomous Controller from the specified STT state. </p>
<dl class="section note"><dt>Note</dt><dd>The AC, in case of emergency hanging up, can be forcibly stopped by the <a class="el" href="group__group__hppass__cfg__functions.html#ga96d3f95d6f156ebfa816a43c3f98ef44">Cy_HPPASS_DeInit</a> only.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">startState</td><td>Starting state index in the State Transition Table.</td></tr>
    <tr><td class="paramname">timeoutUs</td><td>The startup timeout in microseconds. When non-zero - the function waits for the BLOCK_READY status and check the timeout. When zero - the function just triggers AC start command and returns immediately.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status of execution:<ul>
<li>CY_HPPASS_SUCCESS - the AC is started successfully.</li>
<li>CY_HPPASS_AC_INVALID_STATE - the AC is already running.</li>
<li>CY_HPPASS_AC_BAD_PARAM - input parameter is invalid.</li>
<li>CY_HPPASS_VDDA_FAIL - VDDA is out of range.</li>
<li>CY_HPPASS_TIMEOUT - the timeout timer has expired before BLOCK_READY condition. </li>
</ul>
</dd></dl>

</div>
</div>
<a id="gafe3a52cfc422239331c798f8b992ee19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe3a52cfc422239331c798f8b992ee19">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_GetState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_AC_GetState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__hppass__state__t.html">cy_stc_hppass_state_t</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Provides status of operation for the Autonomous Controller. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>Pointer to structure for receiving state regarding operation conditions of the Autonomous Controller, <a class="el" href="structcy__stc__hppass__state__t.html">cy_stc_hppass_state_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status of execution, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>. </dd></dl>

</div>
</div>
<a id="gaec00f468edc0706ae7dcb46c86332caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec00f468edc0706ae7dcb46c86332caa">&#9670;&nbsp;</a></span>Cy_HPPASS_AC_IsBlockReady()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE bool Cy_HPPASS_AC_IsBlockReady </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the AC block ready status. </p>
<dl class="section return"><dt>Returns</dt><dd>Running status: true - ready for use, false - not ready. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
